SearchCriteria

Represents the criteria for searching various objects in Rainbow.

Instances of this class are created using the Builder class, which provides an API for configuring the search criteria.

Types

Link copied to clipboard
class Builder

Builder class for creating instances of SearchCriteria.

Link copied to clipboard

Enum representing the filter to apply to search results.

Properties

Link copied to clipboard

Whether to add the current search as a contact with the email to the results list.

Link copied to clipboard

Whether to add the current search as a contact with the phone number to the results list.

Link copied to clipboard
val searchChannels: Boolean = false

Whether to search channels by name.

Link copied to clipboard
val searchCompanies: Boolean = false

Whether to search companies by name.

Link copied to clipboard
val searchCompanyDirectoryContacts: Boolean = false

Whether to search contacts by name in the company directory.

Link copied to clipboard
val searchDirectoryCompanyId: String? = null

The company ID to restrict the directory search to.

Link copied to clipboard
val searchGroups: Boolean = false

Whether to search groups by name.

Link copied to clipboard
val searchHuntingGroups: Boolean = false

Whether to search hunting groups by name.

Link copied to clipboard
val searchLocalByEmail: Boolean = false

Whether to search local or cached contacts by email.

Link copied to clipboard
val searchLocalContacts: Boolean = false

Whether to search local or cached contacts by name.

Link copied to clipboard
val searchOffice365: Boolean = false

Whether to search Office 365 contacts by name.

Link copied to clipboard

Whether to search contacts by name in the directory of other companies.

Link copied to clipboard
val searchP2PConversations: Boolean = false

Whether to search peer to peer conversations by name.

Link copied to clipboard
val searchPhoneBook: Boolean = false

Whether to search phone book contacts by name.

Link copied to clipboard
val searchRainbowContacts: Boolean = false

Whether to search Rainbow contacts by name.

Link copied to clipboard
val searchRainbowContactsByTags: Boolean = false

Whether to search Rainbow contacts by tags.

Link copied to clipboard

The filter to apply to search results.

Link copied to clipboard
val searchRoomConversations: Boolean = false

Whether to search room conversations by name.

Link copied to clipboard
val searchRooms: Boolean = false

Whether to search rooms by name.

Link copied to clipboard
val searchRoomsByParticipants: Boolean = false

Whether to search rooms by participants name.

Link copied to clipboard
val searchRoomsByTags: Boolean = false

Whether to search rooms by tags.

Link copied to clipboard
val searchTextInConversations: Boolean = false

Whether to search text in conversations.